'\" t
.\"     Title: ndb_redo_log_reader
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 11/26/2022
.\"    Manual: MySQL Database System
.\"    Source: MySQL 8.0
.\"  Language: English
.\"
.TH "NDB_REDO_LOG_READER" "1" "11/26/2022" "MySQL 8\&.0" "MySQL Database System"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ndb_redo_log_reader \- check and print content of cluster redo log
.SH "SYNOPSIS"
.HP \w'\fBndb_redo_log_reader\ \fR\fB\fIfile_name\fR\fR\fB\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u
\fBndb_redo_log_reader \fR\fB\fIfile_name\fR\fR\fB [\fR\fB\fIoptions\fR\fR\fB]\fR
.SH "DESCRIPTION"
.PP
Reads a redo log file, checking it for errors, printing its contents in a human\-readable format, or both\&.
\fBndb_redo_log_reader\fR
is intended for use primarily by NDB Cluster developers and Support personnel in debugging and diagnosing problems\&.
.PP
This utility remains under development, and its syntax and behavior are subject to change in future NDB Cluster releases\&.
.PP
The C++ source files for
\fBndb_redo_log_reader\fR
can be found in the directory
/storage/ndb/src/kernel/blocks/dblqh/redoLogReader\&.
.PP
Options that can be used with
\fBndb_redo_log_reader\fR
are shown in the following table\&. Additional descriptions follow the table\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&23.41.\ \&Command\-line options used with the program ndb_redo_log_reader
.TS
allbox tab(:);
lB lB lB.
T{
Format
T}:T{
Description
T}:T{
Added, Deprecated, or Removed
T}
.T&
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l.
T{
.PP
\fB \fR\fB-dump\fR\fB \fR
T}:T{
Print dump info
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB--file-key=key\fR,
.PP
\fB \fR\fB-K key\fR\fB \fR
T}:T{
Supply decryption key
T}:T{
.PP
ADDED: NDB 8.0.31
T}
T{
.PP
\fB \fR\fB--file-key-from-stdin\fR\fB \fR
T}:T{
Supply decryption key using stdin
T}:T{
.PP
ADDED: NDB 8.0.31
T}
T{
.PP
\fB \fR\fB-filedescriptors\fR\fB \fR
T}:T{
Print file descriptors only
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--help\fR\fB \fR
T}:T{
Print usage information (has no short form)
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB-lap\fR\fB \fR
T}:T{
Provide lap info, with max GCI started and completed
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB-mbyte #\fR\fB \fR
T}:T{
Starting megabyte
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB-mbyteheaders\fR\fB \fR
T}:T{
Show only first page header of each megabyte in file
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB-nocheck\fR\fB \fR
T}:T{
Do not check records for errors
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB-noprint\fR\fB \fR
T}:T{
Do not print records
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB-page #\fR\fB \fR
T}:T{
Start with this page
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB-pageheaders\fR\fB \fR
T}:T{
Show page headers only
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB-pageindex #\fR\fB \fR
T}:T{
Start with this page index
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB-twiddle\fR\fB \fR
T}:T{
Bit-shifted dump
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
.TE
.sp 1
Usage
.sp
.if n \{\
.RS 4
.\}
.nf
ndb_redo_log_reader \fIfile_name\fR [\fIoptions\fR]
.fi
.if n \{\
.RE
.\}
.PP
\fIfile_name\fR
is the name of a cluster redo log file\&. redo log files are located in the numbered directories under the data node\*(Aqs data directory (DataDir); the path under this directory to the redo log files matches the pattern
ndb_\fInodeid\fR_fs/D\fI#\fR/DBLQH/S\fI#\fR\&.FragLog\&.
\fInodeid\fR
is the data node\*(Aqs node ID\&. The two instances of
\fI#\fR
each represent a number (not necessarily the same number); the number following
D
is in the range 8\-39 inclusive; the range of the number following
S
varies according to the value of the
NoOfFragmentLogFiles
configuration parameter, whose default value is 16; thus, the default range of the number in the file name is 0\-15 inclusive\&. For more information, see
\m[blue]\fBNDB Cluster Data Node File System Directory\fR\m[]\&\s-2\u[1]\d\s+2\&.
.PP
The name of the file to be read may be followed by one or more of the options listed here:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-dump\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
-dump
T}
.TE
.sp 1
Print dump info\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-file\-key\fR,
\fB\-K\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--file-key=key
T}
T{
Introduced
T}:T{
8.0.31-ndb-8.0.31
T}
.TE
.sp 1
Supply file decryption key using
stdin,
tty, or a
my\&.cnf
file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-file\-key\-from\-stdin\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--file-key-from-stdin
T}
T{
Introduced
T}:T{
8.0.31-ndb-8.0.31
T}
.TE
.sp 1
Supply file decryption key using
stdin\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
-filedescriptors
T}
.TE
.sp 1
\fB\-filedescriptors\fR: Print file descriptors only\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--help
T}
.TE
.sp 1
\fB\-\-help\fR: Print usage information\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-lap\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
-lap
T}
.TE
.sp 1
Provide lap info, with max GCI started and completed\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.TS
allbox tab(:);
lB l
lB l
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
-mbyte #
T}
T{
Type
T}:T{
Numeric
T}
T{
Default Value
T}:T{
0
T}
T{
Minimum Value
T}:T{
0
T}
T{
Maximum Value
T}:T{
15
T}
.TE
.sp 1
\fB\-mbyte \fR\fB\fI#\fR\fR: Starting megabyte\&.
.sp
\fI#\fR
is an integer in the range 0 to 15, inclusive\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
-mbyteheaders
T}
.TE
.sp 1
\fB\-mbyteheaders\fR: Show only the first page header of every megabyte in the file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
-noprint
T}
.TE
.sp 1
\fB\-noprint\fR: Do not print the contents of the log file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
-nocheck
T}
.TE
.sp 1
\fB\-nocheck\fR: Do not check the log file for errors\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.TS
allbox tab(:);
lB l
lB l
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
-page #
T}
T{
Type
T}:T{
Integer
T}
T{
Default Value
T}:T{
0
T}
T{
Minimum Value
T}:T{
0
T}
T{
Maximum Value
T}:T{
31
T}
.TE
.sp 1
\fB\-page \fR\fB\fI#\fR\fR: Start at this page\&.
.sp
\fI#\fR
is an integer in the range 0 to 31, inclusive\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
-pageheaders
T}
.TE
.sp 1
\fB\-pageheaders\fR: Show page headers only\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.TS
allbox tab(:);
lB l
lB l
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
-pageindex #
T}
T{
Type
T}:T{
Integer
T}
T{
Default Value
T}:T{
12
T}
T{
Minimum Value
T}:T{
12
T}
T{
Maximum Value
T}:T{
8191
T}
.TE
.sp 1
\fB\-pageindex \fR\fB\fI#\fR\fR: Start at this page index\&.
.sp
\fI#\fR
is an integer between 12 and 8191, inclusive\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-twiddle\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
-twiddle
T}
.TE
.sp 1
Bit\-shifted dump\&.
.RE
.PP
Like
\fBndb_print_backup_file\fR
and
\fBndb_print_schema_file\fR
(and unlike most of the
NDB
utilities that are intended to be run on a management server host or to connect to a management server)
\fBndb_redo_log_reader\fR
must be run on a cluster data node, since it accesses the data node file system directly\&. Because it does not make use of the management server, this utility can be used when the management server is not running, and even when the cluster has been completely shut down\&.
.SH "COPYRIGHT"
.br
.PP
Copyright \(co 1997, 2022, Oracle and/or its affiliates.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
.PP
This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.
.sp
.SH "NOTES"
.IP " 1." 4
NDB Cluster Data Node File System Directory
.RS 4
\%https://dev.mysql.com/doc/ndb-internals/en/ndb-internals-ndbd-filesystemdir-files.html
.RE
.SH "SEE ALSO"
For more information, please refer to the MySQL Reference Manual,
which may already be installed locally and which is also available
online at http://dev.mysql.com/doc/.
.SH AUTHOR
Oracle Corporation (http://dev.mysql.com/).
